/**
 * Copyright (C) 2010-2016 eBusiness Information, Excilys Group
 * Copyright (C) 2016-2020 the OhosAnnotations project
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * <p>
 * http://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed To in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */

package org.ohosannotations.annotations;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * <p>
 * This annotation is intended to be used on methods to receive action down
 * event on a key. This annotation can be used on methods of classes which
 * implements {@link ohos.multimodalinput.event.KeyEvent}.
 * </p>
 * <p>
 * The annotation value should be one or several of
 * {@link ohos.multimodalinput.event.KeyEvent} constant fields which name contains KEYCODE. If
 * not set, the method name will be used as the {@link ohos.multimodalinput.event.KeyEvent}
 * .KEYCODE_* field name.
 * </p>
 * <p>
 * The method may return a <code>boolean</code>, <code>void</code>, or a
 * {@link Boolean}. If returning void, it will be considered as returning true
 * (ie: the method has handled the event).
 * </p>
 * <p>
 * The method MAY have one parameter:
 * </p>
 * <ul>
 * <li>A {@link ohos.multimodalinput.event.KeyEvent} parameter to know which key has been down
 * </li>
 * </ul>
 *
 * @see ohos.multimodalinput.event.KeyEvent
 */
@Retention(RetentionPolicy.CLASS)
@Target(ElementType.METHOD)
public @interface KeyDown {
    /**
     * The {@link ohos.multimodalinput.event.KeyEvent} class constants which name contains
     * KEYCODE.
     *
     * @return the value of the key code
     */
    int[] value() default {};
}
